Add SIP Connection

This request adds a SIP Connection for the customer. Once you have setup the primary SIP Connection, you can add additional branch sites and then provision SBC prefixes for the users at this site location.

URL

Copy 
{{baseUrl}}/api/v2/customer/{customerGuid}/sitelocation/

HTTP Method

POST

Request Parameter

Parameter

Type

Description

umpCustomerGuid

string($uuid)

umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Customer from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Essentials Customer.

Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service.

Request Body

Parameter

Type

Description

siteLocationName

string

Desired name of the site location.

ovocCustomerType

string

The supported Live Platform SIP Connection type:

■ IPGROUP_TYPE

sbcId

integer

The SBC Id in the Live Platform database (see Get SBC Devices).

sbcOnboardingScript

integer

The SBC Onboarding script value in the Live Cloud database (see Get Script Templates).

sbcCleanupScript

integer

The SBC Cleanup script value in the Live Cloud database (see Get Script Templates).

scriptParameters

list array

List array including the following parameters:

■ CacProfile
■ ProxySet
■ OnlinePstnGateway
■ CarrierUserName
■ CarrierUserPassword
■ CarrierMailLine
■ CarrierHostName

CacProfile

string

Defines the desired number of Call Admission Control (CAC) call sessions. For example, "10 sessions". This value also represents the name of the CAC profile. See Get SBC Devices for retrieving CAC profiles.

ProxySet

string

The name of the SBC Proxy Set.

OnlinePstnGateway

string

The name of the OnlinePSTN Gateway of the SBC device that is attached to the Calling Profile (see Get Online PSTN Gateway.

CarrierUserName

string

Defines the digest MD5 Authentication username. The valid value is a string of up to 60 characters. By default, no value is defined.

CarrierUserPassword

string

Defines the digest MD5 Authentication password. The valid value is a string of up to 50 characters. Note: The password cannot be configured with wide characters.

CarrierMainLine

string

Defines the AOR username. This appears in REGISTER From/To headers as ContactUser@HostName.

CarrierHostName

string

Defines the Address of Record (AOR) host name. The host name appears in SIP REGISTER From/To headers as ContactUser@HostName.

CustomVar.Variable<VariableSequenceNumber>

string

where <VariableSequenceNumber> is the sequence in database that the variable is defined in the 'Customer variables' column for the script properties (see Customer Variables).

For example, when the following IP-PBX variables are defined in the database in the order: IPPBX-ProxyAddress, IPPBX-ProxyAddress-SIPPort, SIP-HostName then Custom variables should be defined as follows:

■ CustomVar.Variable1: <: IPPBX-ProxyAddress>
■ CustomVar.Variable2: < IPPBX-ProxyAddress-SIPPort>
■ CustomVar.Variable3: <SIP-HostName>

 

Custom variables can be defined to update specific parameters on the SBC device. These variables must be predefined in the UMP-365 database (see Customer Variables). Also verify that the custom variables notation has been added to the script (see parameter 'sbcOnboardingScript' above) that you are applying to this request.

There is no limitation for the number of variables that are added.

additionalProp1

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name

additionalProp2

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name

additionalProp3

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name

Example Body

Copy 
{ "siteLocationName": "SaraSite4",
  "ovocCustomerType": "IPGROUP_TYPE",  
  "sbcId": 5,
  "sbcOnboardingScript": 10007,
  "sbcCleanupScript": 10700,
  "SbcConfigurationType": 1,
  "scriptParameters": 
  {    
  "OnlinePstnGateway": "sandbox1.audiocodes.be",    
  "ProxySet": "SIPTrunk",    
  "CarrierUserName": "1000",    
  "CarrierUserPassword": "12345678",    
  "CarrierMainLine": "brad1",    
  "CarrierHostName": "brad.com",    
  "CacProfile": "5 sessions"
    }
}

Example Response

Copy 
{
    "customerGuid": "b38e5a04-6d32-4be8-95bb-53bf7d6fa95c",
    "siteGuid": "a344470f-e54e-4897-b28e-d1c2c0c404f0",
    "executionMessages": [
        {
            "level": "Information",
            "message": "Skipping SBC CheckIpGroupProgramming."
        },
        {
            "level": "Information",
            "message": "Starting SBC Programming."
        },
        {
            "level": "Information",
            "message": "Sbc is programmed"
        },
        {
            "level": "Information",
            "message": "Site location information saved."
        }
    ]
}

HTTP Responses

■ 200 OK
Parameter Type Description

Customer Id

string($uuid)

Unique Id generated for customer. Search for the customer Id by searching for your customer name using Get Services Brief Details (V3).

siteGuid

string($uuid)

Unique Id generated for the SIP Connection location.

executionMessages

list array

List array including the following parameters:

■ level
■ message

level

string

One of the following values:

■ Information
■ Error

message

string

Information message text includes the following strings:

■ Checking SBC IP Group Programming
■ SBC not programmed yet
■ Starting SBC Programming
■ Sbc is programmed
■ Site location information saved